<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>DocParser - YUIDoc</title>
    <link rel="stylesheet" href="https://yui-s.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="icon" href="../assets/favicon.ico">
    <script src="https://yui-s.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
                <h1><img src="../assets/css/logo.png" title="YUIDoc" width="117" height="52"></h1>
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: 0.10.0</em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
                    <h2 class="off-left">APIs</h2>
                    <div id="api-tabview" class="tabview">
                        <ul class="tabs">
                            <li><a href="#api-classes">Classes</a></li>
                            <li><a href="#api-modules">Modules</a></li>
                        </ul>
                
                        <div id="api-tabview-filter">
                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
                        </div>
                
                        <div id="api-tabview-panel">
                            <ul id="api-classes" class="apis classes">
                                <li><a href="../classes/CLI.html">CLI</a></li>
                                <li><a href="../classes/DocBuilder.html">DocBuilder</a></li>
                                <li><a href="../classes/DocParser.html">DocParser</a></li>
                                <li><a href="../classes/DocView.html">DocView</a></li>
                                <li><a href="../classes/Files.html">Files</a></li>
                                <li><a href="../classes/Help.html">Help</a></li>
                                <li><a href="../classes/Main.html">Main</a></li>
                                <li><a href="../classes/Options.html">Options</a></li>
                                <li><a href="../classes/Server.html">Server</a></li>
                                <li><a href="../classes/Utils.html">Utils</a></li>
                                <li><a href="../classes/YUIDoc.html">YUIDoc</a></li>
                            </ul>
                
                
                            <ul id="api-modules" class="apis modules">
                                <li><a href="../modules/yuidoc.html">yuidoc</a></li>
                            </ul>
                        </div>
                    </div>
                </div>
            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
                    Show:
                    <label for="api-show-inherited">
                        <input type="checkbox" id="api-show-inherited" checked>
                        Inherited
                    </label>
            
                    <label for="api-show-protected">
                        <input type="checkbox" id="api-show-protected">
                        Protected
                    </label>
            
                    <label for="api-show-private">
                        <input type="checkbox" id="api-show-private">
                        Private
                    </label>
                    <label for="api-show-deprecated">
                        <input type="checkbox" id="api-show-deprecated">
                        Deprecated
                    </label>
            
                </div>
            
            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
<h1>DocParser Class</h1>
<div class="box meta">

        <div class="extends">
            Extends <a href="http://yuilibrary.com/yui/docs/api/classes/Base.html" class="crosslink external" target="_blank">Base</a>
        </div>

        <div class="foundat">
            Defined in: <a href="../files/lib_docparser.js.html#l794"><code>lib&#x2F;docparser.js:794</code></a>
        </div>

            Module: <a href="../modules/yuidoc.html">yuidoc</a>

</div>


<div class="box intro">
    <p>The doc parser accepts a <strong>map</strong> of files to file content.
Once <code>parse()</code> is called, various properties will be populated
with the parsers data (aggregated in the <code>'data'</code> property).</p>

</div>

    <div class="constructor">
        <h2>Constructor</h2>
<div id="method_DocParser" class="method item">
    <h3 class="name"><code>DocParser</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>o</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l794"><code>lib&#x2F;docparser.js:794</code></a>
        </p>



    </div>

    <div class="description">
        
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">o</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        <p>the config object</p>

                    </div>

                </li>
            </ul>
        </div>



</div>
    </div>

<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
            <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
            <li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>
            <li class="api-class-tab events"><a href="#events">Events</a></li>
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods extends">
                            <li class="index-item method private inherited">
                                <a href="#method__addAttrs">_addAttrs</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__addLazyAttr">_addLazyAttr</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__addOutOfOrder">_addOutOfOrder</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__aggregateAttrs">_aggregateAttrs</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__attrCfgHash">_attrCfgHash</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__baseDestroy">_baseDestroy</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__baseInit">_baseInit</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__cloneDefaultValue">_cloneDefaultValue</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__defAttrChangeFn">_defAttrChangeFn</a>

                            </li>
                            <li class="index-item method protected inherited">
                                <a href="#method__defDestroyFn">_defDestroyFn</a>

                            </li>
                            <li class="index-item method protected inherited">
                                <a href="#method__defInitFn">_defInitFn</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__destroyHierarchy">_destroyHierarchy</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__fireAttrChange">_fireAttrChange</a>

                            </li>
                            <li class="index-item method protected inherited">
                                <a href="#method__getAttr">_getAttr</a>

                            </li>
                            <li class="index-item method protected inherited">
                                <a href="#method__getAttrCfg">_getAttrCfg</a>

                            </li>
                            <li class="index-item method protected inherited">
                                <a href="#method__getAttrCfgs">_getAttrCfgs</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__getAttrInitVal">_getAttrInitVal</a>

                            </li>
                            <li class="index-item method protected inherited">
                                <a href="#method__getAttrs">_getAttrs</a>

                            </li>
                            <li class="index-item method protected inherited">
                                <a href="#method__getClasses">_getClasses</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__getFullType">_getFullType</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__getInstanceAttrCfgs">_getInstanceAttrCfgs</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__getStateVal">_getStateVal</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__getType">_getType</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__hasPotentialSubscribers">_hasPotentialSubscribers</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__initAttrHost">_initAttrHost</a>

                            </li>
                            <li class="index-item method private inherited inherited">
                                <a href="#method__initAttribute">_initAttribute</a>

                            </li>
                            <li class="index-item method protected inherited">
                                <a href="#method__initAttrs">_initAttrs</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__initBase">_initBase</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__initHierarchy">_initHierarchy</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__initHierarchyData">_initHierarchyData</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__isLazyAttr">_isLazyAttr</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__monitor">_monitor</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__normAttrVals">_normAttrVals</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__parseType">_parseType</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__preInitEventCfg">_preInitEventCfg</a>

                            </li>
                            <li class="index-item method protected deprecated inherited">
                                <a href="#method__protectAttrs">_protectAttrs</a>

                                    <span class="flag deprecated">deprecated</span>
                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__publish">_publish</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method__resolveFor">_resolveFor</a>

                            </li>
                            <li class="index-item method protected inherited inherited">
                                <a href="#method__set">_set</a>

                            </li>
                            <li class="index-item method protected inherited">
                                <a href="#method__setAttr">_setAttr</a>

                            </li>
                            <li class="index-item method protected inherited inherited">
                                <a href="#method__setAttrs">_setAttrs</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__setAttrVal">_setAttrVal</a>

                            </li>
                            <li class="index-item method private inherited">
                                <a href="#method__setStateVal">_setStateVal</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_addAttr">addAttr</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_addAttrs">addAttrs</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_addTarget">addTarget</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_after">after</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_attrAdded">attrAdded</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_before">before</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_bubble">bubble</a>

                            </li>
                            <li class="index-item method inherited inherited">
                                <a href="#method_destroy">destroy</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_detach">detach</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_detachAll">detachAll</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_extract">extract</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_fire">fire</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_get">get</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_getAttrs">getAttrs</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_getEvent">getEvent</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_getTargets">getTargets</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_handlecomment">handlecomment</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_implodeString">implodeString</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_implodeString">implodeString</a>

                            </li>
                            <li class="index-item method inherited inherited">
                                <a href="#method_init">init</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_modifyAttr">modifyAttr</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_on">on</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_once">once</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_onceAfter">onceAfter</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_parse">parse</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_parseType">parseType</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_processblock">processblock</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_publish">publish</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_removeAttr">removeAttr</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_removeTarget">removeTarget</a>

                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_reset">reset</a>

                            </li>
                            <li class="index-item method inherited inherited">
                                <a href="#method_set">set</a>

                            </li>
                            <li class="index-item method inherited inherited">
                                <a href="#method_setAttrs">setAttrs</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_stringlog">stringlog</a>

                            </li>
                            <li class="index-item method deprecated inherited">
                                <a href="#method_subscribe">subscribe</a>

                                    <span class="flag deprecated">deprecated</span>
                            </li>
                            <li class="index-item method inherited">
                                <a href="#method_toString">toString</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_transform">transform</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_unindent">unindent</a>

                            </li>
                            <li class="index-item method deprecated inherited">
                                <a href="#method_unsubscribe">unsubscribe</a>

                                    <span class="flag deprecated">deprecated</span>
                            </li>
                            <li class="index-item method deprecated inherited">
                                <a href="#method_unsubscribeAll">unsubscribeAll</a>

                                    <span class="flag deprecated">deprecated</span>
                            </li>
                    </ul>
                </div>

                <div class="index-section properties">
                    <h3>Properties</h3>

                    <ul class="index-list properties extends">
                            <li class="index-item property protected inherited">
                                <a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_CORRECTIONS">CORRECTIONS</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_DIGESTERS">DIGESTERS</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_IGNORE_TAGLIST">IGNORE_TAGLIST</a>

                            </li>
                            <li class="index-item property deprecated inherited">
                                <a href="#property_name">name</a>

                                    <span class="flag deprecated">deprecated</span>
                            </li>
                            <li class="index-item property">
                                <a href="#property_TAGLIST">TAGLIST</a>

                            </li>
                    </ul>
                </div>

                <div class="index-section attrs">
                    <h3>Attributes</h3>

                    <ul class="index-list attrs extends">
                            <li class="index-item attr">
                                <a href="#attr_currentclass">currentclass</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_currentelement">currentelement</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_currentfile">currentfile</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_currentmodule">currentmodule</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_currentsubmodule">currentsubmodule</a>
                            </li>
                            <li class="index-item attr inherited">
                                <a href="#attr_destroyed">destroyed</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_digesters">digesters</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_dirmap">dirmap</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_emitters">emitters</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_filemap">filemap</a>
                            </li>
                            <li class="index-item attr inherited">
                                <a href="#attr_initialized">initialized</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_mainmodule">mainmodule</a>
                            </li>
                            <li class="index-item attr">
                                <a href="#attr_syntaxtype">syntaxtype</a>
                            </li>
                    </ul>
                </div>

                <div class="index-section events">
                    <h3>Events</h3>

                    <ul class="index-list events extends">
                            <li class="index-item event inherited">
                                <a href="#event_destroy">destroy</a>

                            </li>
                            <li class="index-item event inherited">
                                <a href="#event_init">init</a>

                            </li>
                    </ul>
                </div>
        </div>

            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

<div id="method__addAttrs" class="method item private inherited">
    <h3 class="name"><code>_addAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>cfgs</code>
                </li>
                <li class="arg">
                        <code>values</code>
                </li>
                <li class="arg">
                        <code>lazy</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__addAttrs">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l854"><code>attribute&#x2F;js&#x2F;AttributeCore.js:854</code></a>
        </p>



    </div>

    <div class="description">
        Implementation behind the public addAttrs method.

This method is invoked directly by get if it encounters a scenario
in which an attribute's valueFn attempts to obtain the
value an attribute in the same group of attributes, which has not yet
been added (on demand initialization).
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">cfgs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        An object with attribute name/configuration pairs.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">values</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        An object with attribute name/value pairs, defining the initial values to apply.
Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">lazy</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


                    <div class="param-description">
                        Whether or not to delay the intialization of these attributes until the first call to get/set.
Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
See <a href="#method_addAttr">addAttr</a>.
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__addLazyAttr" class="method item private inherited">
    <h3 class="name"><code>_addLazyAttr</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code class="optional">[lazyCfg]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l360"><code>attribute&#x2F;js&#x2F;AttributeCore.js:360</code></a>
        </p>



    </div>

    <div class="description">
        Finishes initializing an attribute which has been lazily added.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The name of the attribute
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[lazyCfg]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Optional config hash for the attribute. This is added for performance
along the critical path, where the calling method has already obtained lazy config from state.
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__addOutOfOrder" class="method item private inherited">
    <h3 class="name"><code>_addOutOfOrder</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code>cfg</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__addOutOfOrder">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l527"><code>attribute&#x2F;js&#x2F;AttributeCore.js:527</code></a>
        </p>



    </div>

    <div class="description">
        Utility method used by get/set to add attributes
encountered out of order when calling addAttrs().

For example, if:

    this.addAttrs({
         foo: {
             setter: function() {
                // make sure this bar is available when foo is added
                this.get("bar");
             }
         },
         bar: {
             value: ...
         }
    });
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        attribute name
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">cfg</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        attribute configuration
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__aggregateAttrs" class="method item private inherited">
    <h3 class="name"><code>_aggregateAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>allAttrs</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l618"><code>base&#x2F;js&#x2F;BaseCore.js:618</code></a>
        </p>



    </div>

    <div class="description">
        A helper method, used by _initHierarchyData to aggregate
attribute configuration across the instances class hierarchy.

The method will protect the attribute configuration value to protect the statically defined
default value in ATTRS if required (if the value is an object literal, array or the
attribute configuration has cloneDefaultValue set to shallow or deep).
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">allAttrs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>


                    <div class="param-description">
                        An array of ATTRS definitions across classes in the hierarchy
(subclass first, Base last)
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    The aggregate set of ATTRS definitions for the instance
            </div>
        </div>


</div>
<div id="method__attrCfgHash" class="method item private inherited">
    <h3 class="name"><code>_attrCfgHash</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__attrCfgHash">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l581"><code>base&#x2F;js&#x2F;BaseCore.js:581</code></a>
        </p>



    </div>

    <div class="description">
        Utility method to define the attribute hash used to filter/whitelist property mixes for
this class for iteration performance reasons.
    </div>




</div>
<div id="method__baseDestroy" class="method item private inherited">
    <h3 class="name"><code>_baseDestroy</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__baseDestroy">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l364"><code>base&#x2F;js&#x2F;BaseCore.js:364</code></a>
        </p>



    </div>

    <div class="description">
        Internal destroy implementation for BaseCore
    </div>




</div>
<div id="method__baseInit" class="method item private inherited">
    <h3 class="name"><code>_baseInit</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__baseInit">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l336"><code>base&#x2F;js&#x2F;BaseCore.js:336</code></a>
        </p>



    </div>

    <div class="description">
        Internal initialization implementation for BaseCore
    </div>




</div>
<div id="method__cloneDefaultValue" class="method item private inherited">
    <h3 class="name"><code>_cloneDefaultValue</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>cfg</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__cloneDefaultValue">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l592"><code>base&#x2F;js&#x2F;BaseCore.js:592</code></a>
        </p>



    </div>

    <div class="description">
        This method assumes that the value has already been checked to be an object.
Since it's on a critical path, we don't want to re-do the check.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">cfg</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__defAttrChangeFn" class="method item private inherited">
    <h3 class="name"><code>_defAttrChangeFn</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>e</code>
                </li>
                <li class="arg">
                        <code>eventFastPath</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeObservable.html#method__defAttrChangeFn">AttributeObservable</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeObservable.js.html#l185"><code>attribute&#x2F;js&#x2F;AttributeObservable.js:185</code></a>
        </p>



    </div>

    <div class="description">
        Default function for attribute change events.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">e</code>
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>


                    <div class="param-description">
                        The event object for attribute change events.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">eventFastPath</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


                    <div class="param-description">
                        Whether or not we're using this as a fast path in the case of no listeners or not
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__defDestroyFn" class="method item protected inherited">
    <h3 class="name"><code>_defDestroyFn</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>e</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag protected">protected</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#method__defDestroyFn">BaseObservable</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseObservable.js.html#l202"><code>base&#x2F;js&#x2F;BaseObservable.js:202</code></a>
        </p>



    </div>

    <div class="description">
        Default destroy event handler
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">e</code>
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>


                    <div class="param-description">
                        Event object
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__defInitFn" class="method item protected inherited">
    <h3 class="name"><code>_defInitFn</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>e</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag protected">protected</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#method__defInitFn">BaseObservable</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseObservable.js.html#l190"><code>base&#x2F;js&#x2F;BaseObservable.js:190</code></a>
        </p>



    </div>

    <div class="description">
        Default init event handler
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">e</code>
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>


                    <div class="param-description">
                        Event object, with a cfg property which
refers to the configuration object passed to the constructor.
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__destroyHierarchy" class="method item private inherited">
    <h3 class="name"><code>_destroyHierarchy</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l782"><code>base&#x2F;js&#x2F;BaseCore.js:782</code></a>
        </p>



    </div>

    <div class="description">
        Destroys the class hierarchy for this instance by invoking
the destructor method on the prototype of each class in the hierarchy.
    </div>




</div>
<div id="method__filterAdHocAttrs" class="method item private inherited">
    <h3 class="name"><code>_filterAdHocAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>allAttrs</code>
                </li>
                <li class="arg">
                        <code>userVals</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l470"><code>base&#x2F;js&#x2F;BaseCore.js:470</code></a>
        </p>



    </div>

    <div class="description">
        
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">allAttrs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The set of all attribute configurations for this instance.
Attributes will be removed from this set, if they belong to the filtered class, so
that by the time all classes are processed, allCfgs will be empty.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">userVals</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The config object passed in by the user, from which adhoc attrs are to be filtered.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    The set of adhoc attributes passed in, in the form
of an object with attribute name/configuration pairs.
            </div>
        </div>


</div>
<div id="method__fireAttrChange" class="method item private inherited">
    <h3 class="name"><code>_fireAttrChange</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attrName</code>
                </li>
                <li class="arg">
                        <code>subAttrName</code>
                </li>
                <li class="arg">
                        <code>currVal</code>
                </li>
                <li class="arg">
                        <code>newVal</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code class="optional">[cfg]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeObservable.html#method__fireAttrChange">AttributeObservable</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeObservable.js.html#l120"><code>attribute&#x2F;js&#x2F;AttributeObservable.js:120</code></a>
        </p>



    </div>

    <div class="description">
        Utility method to help setup the event payload and fire the attribute change event.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attrName</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">subAttrName</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The full path of the property being changed,
if this is a sub-attribute value being change. Otherwise null.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">currVal</code>
                        <span class="type">Any</span>


                    <div class="param-description">
                        The current value of the attribute
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">newVal</code>
                        <span class="type">Any</span>


                    <div class="param-description">
                        The new value of the attribute
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        Any additional event data to mix into the attribute change event's event facade.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[cfg]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        The attribute config stored in State, if already available.
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__getAttr" class="method item protected inherited">
    <h3 class="name"><code>_getAttr</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Any</span>
        </span>


        <span class="flag protected">protected</span>



        <span class="flag chainable">chainable</span>


    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__getAttr">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l564"><code>attribute&#x2F;js&#x2F;AttributeCore.js:564</code></a>
        </p>



    </div>

    <div class="description">
        Provides the common implementation for the public get method,
allowing Attribute hosts to over-ride either method.

See <a href="#method_get">get</a> for argument details.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Any</span>:
                    The value of the attribute.
            </div>
        </div>


</div>
<div id="method__getAttrCfg" class="method item protected inherited">
    <h3 class="name"><code>_getAttrCfg</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag protected">protected</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeExtras.js.html#l125"><code>attribute&#x2F;js&#x2F;AttributeExtras.js:125</code></a>
        </p>



    </div>

    <div class="description">
        Returns an object with the configuration properties (and value)
for the given attribute. If attrName is not provided, returns the
configuration properties for all attributes.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    The configuration properties for the given attribute, or all attributes.
            </div>
        </div>


</div>
<div id="method__getAttrCfgs" class="method item protected inherited">
    <h3 class="name"><code>_getAttrCfgs</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag protected">protected</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l394"><code>base&#x2F;js&#x2F;BaseCore.js:394</code></a>
        </p>



    </div>

    <div class="description">
        Returns an aggregated set of attribute configurations, by traversing
the class hierarchy.
    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    The hash of attribute configurations, aggregated across classes in the hierarchy
This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return
the cached value.
            </div>
        </div>


</div>
<div id="method__getAttrInitVal" class="method item private inherited">
    <h3 class="name"><code>_getAttrInitVal</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attr</code>
                </li>
                <li class="arg">
                        <code>cfg</code>
                </li>
                <li class="arg">
                        <code>initValues</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Any</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__getAttrInitVal">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l963"><code>attribute&#x2F;js&#x2F;AttributeCore.js:963</code></a>
        </p>



    </div>

    <div class="description">
        Returns the initial value of the given attribute from
either the default configuration provided, or the
over-ridden value if it exists in the set of initValues
provided and the attribute is not read-only.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attr</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">cfg</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The attribute configuration object
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">initValues</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The object with simple and complex attribute name/value pairs returned from _normAttrVals
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Any</span>:
                    The initial value of the attribute.
            </div>
        </div>


</div>
<div id="method__getAttrs" class="method item protected inherited">
    <h3 class="name"><code>_getAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attrs</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag protected">protected</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__getAttrs">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l792"><code>attribute&#x2F;js&#x2F;AttributeCore.js:792</code></a>
        </p>



    </div>

    <div class="description">
        Implementation behind the public getAttrs method, to get multiple attribute values.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attrs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


                    <div class="param-description">
                        Optional. An array of attribute names. If omitted, all attribute values are
returned. If set to true, all attributes modified from their initial values are returned.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    An object with attribute name/value pairs.
            </div>
        </div>


</div>
<div id="method__getClasses" class="method item protected inherited">
    <h3 class="name"><code>_getClasses</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>
        </span>


        <span class="flag protected">protected</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__getClasses">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l378"><code>base&#x2F;js&#x2F;BaseCore.js:378</code></a>
        </p>



    </div>

    <div class="description">
        Returns the class hierarchy for this object, with BaseCore being the last class in the array.
    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>:
                    An array of classes (constructor functions), making up the class hierarchy for this object.
This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the
cached value.
            </div>
        </div>


</div>
<div id="method__getFullType" class="method item private inherited">
    <h3 class="name"><code>_getFullType</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method__getFullType">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l564"><code>event-custom&#x2F;js&#x2F;event-target.js:564</code></a>
        </p>



    </div>

    <div class="description">
        Returns the fully qualified type, given a short type string.
That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.

NOTE: This method, unlike _getType, does no checking of the value passed in, and
is designed to be used with the low level _publish() method, for critical path
implementations which need to fast-track publish for performance reasons.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The short type to prefix
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    The prefixed type, if a prefix is set, otherwise the type passed in
            </div>
        </div>


</div>
<div id="method__getInstanceAttrCfgs" class="method item private inherited">
    <h3 class="name"><code>_getInstanceAttrCfgs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>allCfgs</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__getInstanceAttrCfgs">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l411"><code>base&#x2F;js&#x2F;BaseCore.js:411</code></a>
        </p>



    </div>

    <div class="description">
        A helper method used to isolate the attrs config for this instance to pass to <code>addAttrs</code>,
from the static cached ATTRS for the class.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">allCfgs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The set of all attribute configurations for this instance.
Attributes will be removed from this set, if they belong to the filtered class, so
that by the time all classes are processed, allCfgs will be empty.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    The set of attributes to be added for this instance, suitable
for passing through to <code>addAttrs</code>.
            </div>
        </div>


</div>
<div id="method__getStateVal" class="method item private inherited">
    <h3 class="name"><code>_getStateVal</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code class="optional">[cfg]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Any</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__getStateVal">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l618"><code>attribute&#x2F;js&#x2F;AttributeCore.js:618</code></a>
        </p>



    </div>

    <div class="description">
        Gets the stored value for the attribute, from either the
internal state object, or the state proxy if it exits
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[cfg]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Optional config hash for the attribute. This is added for performance along the critical path,
where the calling method has already obtained the config from state.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Any</span>:
                    The stored value of the attribute
            </div>
        </div>


</div>
<div id="method__getType" class="method item private inherited">
    <h3 class="name"><code>_getType</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method__getType">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l36"><code>event-custom&#x2F;js&#x2F;event-target.js:36</code></a>
        </p>



    </div>

    <div class="description">
        If the instance has a prefix attribute and the
event type is not prefixed, the instance prefix is
applied to the supplied type.
    </div>




</div>
<div id="method__hasPotentialSubscribers" class="method item private inherited">
    <h3 class="name"><code>_hasPotentialSubscribers</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>fullType</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method__hasPotentialSubscribers">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-facade.js.html#l643"><code>event-custom&#x2F;js&#x2F;event-facade.js:643</code></a>
        </p>



    </div>

    <div class="description">
        
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">fullType</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The fully prefixed type name
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    Whether the event has potential subscribers or not
            </div>
        </div>


</div>
<div id="method__initAttrHost" class="method item private inherited">
    <h3 class="name"><code>_initAttrHost</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attrs</code>
                </li>
                <li class="arg">
                        <code>values</code>
                </li>
                <li class="arg">
                        <code>lazy</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l140"><code>attribute&#x2F;js&#x2F;AttributeCore.js:140</code></a>
        </p>



    </div>

    <div class="description">
        Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the
constructor.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attrs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>).
       These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">values</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>).
       These are not merged/cloned. The caller is responsible for isolating user provided values if required.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">lazy</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


                    <div class="param-description">
                        Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__initAttribute" class="method item private inherited">
    <h3 class="name"><code>_initAttribute</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
            <p>Inherited from
            <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#method__initAttribute">
                BaseObservable
            </a>
            but overwritten in
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l309"><code>base&#x2F;js&#x2F;BaseCore.js:309</code></a>
        </p>



    </div>

    <div class="description">
        Initializes AttributeCore
    </div>




</div>
<div id="method__initAttrs" class="method item protected inherited">
    <h3 class="name"><code>_initAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attrs</code>
                </li>
                <li class="arg">
                        <code>values</code>
                </li>
                <li class="arg">
                        <code>lazy</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag protected">protected</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__initAttrs">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l1029"><code>attribute&#x2F;js&#x2F;AttributeCore.js:1029</code></a>
        </p>



    </div>

    <div class="description">
        Utility method to set up initial attributes defined during construction,
either through the constructor.ATTRS property, or explicitly passed in.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attrs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>).
       These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">values</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>).
       These are not merged/cloned. The caller is responsible for isolating user provided values if required.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">lazy</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


                    <div class="param-description">
                        Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__initBase" class="method item private inherited">
    <h3 class="name"><code>_initBase</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>config</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__initBase">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l274"><code>base&#x2F;js&#x2F;BaseCore.js:274</code></a>
        </p>



    </div>

    <div class="description">
        Internal construction logic for BaseCore.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">config</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The constructor configuration object
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__initHierarchy" class="method item private inherited">
    <h3 class="name"><code>_initHierarchy</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>userVals</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__initHierarchy">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l702"><code>base&#x2F;js&#x2F;BaseCore.js:702</code></a>
        </p>



    </div>

    <div class="description">
        Initializes the class hierarchy for the instance, which includes
initializing attributes for each class defined in the class's
static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and
invoking the initializer method on the prototype of each class in the hierarchy.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">userVals</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        Object with configuration property name/value pairs
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__initHierarchyData" class="method item private inherited">
    <h3 class="name"><code>_initHierarchyData</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__initHierarchyData">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l500"><code>base&#x2F;js&#x2F;BaseCore.js:500</code></a>
        </p>



    </div>

    <div class="description">
        A helper method used by _getClasses and _getAttrCfgs, which determines both
the array of classes and aggregate set of attribute configurations
across the class hierarchy for the instance.
    </div>




</div>
<div id="method__isLazyAttr" class="method item private inherited">
    <h3 class="name"><code>_isLazyAttr</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l347"><code>attribute&#x2F;js&#x2F;AttributeCore.js:347</code></a>
        </p>



    </div>

    <div class="description">
        Checks whether or not the attribute is one which has been
added lazily and still requires initialization.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    true if it's a lazily added attribute, false otherwise.
            </div>
        </div>


</div>
<div id="method__monitor" class="method item private inherited">
    <h3 class="name"><code>_monitor</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>what</code>
                </li>
                <li class="arg">
                        <code>eventType</code>
                </li>
                <li class="arg">
                        <code>o</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method__monitor">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l636"><code>event-custom&#x2F;js&#x2F;event-target.js:636</code></a>
        </p>



    </div>

    <div class="description">
        This is the entry point for the event monitoring system.
You can monitor 'attach', 'detach', 'fire', and 'publish'.
When configured, these events generate an event.  click ->
click_attach, click_detach, click_publish -- these can
be subscribed to like other events to monitor the event
system.  Inividual published events can have monitoring
turned on or off (publish can't be turned off before it
it published) by setting the events 'monitor' config.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">what</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        'attach', 'detach', 'fire', or 'publish'
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">eventType</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="http://yuilibrary.com/yui/docs/api/classes/CustomEvent.html" class="crosslink external" target="_blank">CustomEvent</a></span>


                    <div class="param-description">
                        The prefixed name of the event being monitored, or the CustomEvent object.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">o</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        Information about the event interaction, such as
                 fire() args, subscription category, publish config
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__normAttrVals" class="method item private inherited">
    <h3 class="name"><code>_normAttrVals</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>valueHash</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__normAttrVals">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l915"><code>attribute&#x2F;js&#x2F;AttributeCore.js:915</code></a>
        </p>



    </div>

    <div class="description">
        Utility method to normalize attribute values. The base implementation
simply merges the hash to protect the original.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">valueHash</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        An object with attribute name/value pairs
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    An object literal with 2 properties - "simple" and "complex",
containing simple and complex attribute values respectively keyed
by the top level attribute name, or null, if valueHash is falsey.
            </div>
        </div>


</div>
<div id="method__parseType" class="method item private inherited">
    <h3 class="name"><code>_parseType</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method__parseType">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l52"><code>event-custom&#x2F;js&#x2F;event-target.js:52</code></a>
        </p>



    </div>

    <div class="description">
        Returns an array with the detach key (if provided),
and the prefixed event name from _getType
Y.on('detachcategory| menu:click', fn)
    </div>




</div>
<div id="method__preInitEventCfg" class="method item private inherited">
    <h3 class="name"><code>_preInitEventCfg</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>config</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#method__preInitEventCfg">BaseObservable</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseObservable.js.html#l110"><code>base&#x2F;js&#x2F;BaseObservable.js:110</code></a>
        </p>



    </div>

    <div class="description">
        Handles the special on, after and target properties which allow the user to
easily configure on and after listeners as well as bubble targets during
construction, prior to init.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">config</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The user configuration object
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method__protectAttrs" class="method item protected deprecated inherited">
    <h3 class="name"><code>_protectAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attrs</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>

        <span class="flag deprecated" title="Use &#x60;AttributeCore.protectAttrs()&#x60; or
  &#x60;Attribute.protectAttrs()&#x60; which are the same static utility method.">deprecated</span>

        <span class="flag protected">protected</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l901"><code>attribute&#x2F;js&#x2F;AttributeCore.js:901</code></a>
        </p>


            <p>Deprecated: Use &#x60;AttributeCore.protectAttrs()&#x60; or
  &#x60;Attribute.protectAttrs()&#x60; which are the same static utility method.</p>

    </div>

    <div class="description">
        Utility method to protect an attribute configuration
hash, by merging the entire object and the individual
attr config objects.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attrs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        A hash of attribute to configuration object pairs.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    A protected version of the attrs argument.
            </div>
        </div>


</div>
<div id="method__publish" class="method item private inherited">
    <h3 class="name"><code>_publish</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>fullType</code>
                </li>
                <li class="arg">
                        <code>etOpts</code>
                </li>
                <li class="arg">
                        <code>ceOpts</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/CustomEvent.html" class="crosslink external" target="_blank">CustomEvent</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method__publish">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l588"><code>event-custom&#x2F;js&#x2F;event-target.js:588</code></a>
        </p>



    </div>

    <div class="description">
        The low level event publish implementation. It expects all the massaging to have been done
outside of this method. e.g. the <code>type</code> to <code>fullType</code> conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">fullType</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The prefixed type of the event to publish.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">etOpts</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The EventTarget specific configuration to mix into the published event.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">ceOpts</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The publish specific configuration to mix into the published event.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/CustomEvent.html" class="crosslink external" target="_blank">CustomEvent</a></span>:
                    The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will
be the default <code>CustomEvent</code> instance, and can be configured independently.
            </div>
        </div>


</div>
<div id="method__resolveFor" class="method item private">
    <h3 class="name"><code>_resolveFor</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>value</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l1110"><code>lib&#x2F;docparser.js:1110</code></a>
        </p>



    </div>

    <div class="description">
        <p>Takes a non-namespaced classname and resolves it to a namespace (to support <code>@for</code>)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">value</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        <p>The classname to resolve</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    <p>The resolved namespace + classname</p>

            </div>
        </div>


</div>
<div id="method__set" class="method item protected inherited">
    <h3 class="name"><code>_set</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code>val</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag protected">protected</span>



        <span class="flag chainable">chainable</span>


    <div class="meta">
            <p>Inherited from
            <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeObservable.html#method__set">
                AttributeObservable
            </a>
            but overwritten in
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l405"><code>attribute&#x2F;js&#x2F;AttributeCore.js:405</code></a>
        </p>



    </div>

    <div class="description">
        Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">val</code>
                        <span class="type">Any</span>


                    <div class="param-description">
                        The value to set the attribute to.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Optional data providing the circumstances for the change.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    A reference to the host object.
            </div>
        </div>


</div>
<div id="method__setAttr" class="method item protected inherited">
    <h3 class="name"><code>_setAttr</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code>value</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts]</code>
                </li>
                <li class="arg">
                        <code>force</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag protected">protected</span>



        <span class="flag chainable">chainable</span>


    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__setAttr">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l421"><code>attribute&#x2F;js&#x2F;AttributeCore.js:421</code></a>
        </p>



    </div>

    <div class="description">
        Provides the common implementation for the public set and protected _set methods.

See <a href="#method_set">set</a> for argument details.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">value</code>
                        <span class="type">Any</span>


                    <div class="param-description">
                        The value to set the attribute to.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Optional data providing the circumstances for the change.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">force</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


                    <div class="param-description">
                        If true, allows the caller to set values for
readOnly or writeOnce attributes which have already been set.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    A reference to the host object.
            </div>
        </div>


</div>
<div id="method__setAttrs" class="method item protected inherited">
    <h3 class="name"><code>_setAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attrs</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>


        <span class="flag protected">protected</span>



        <span class="flag chainable">chainable</span>


    <div class="meta">
            <p>Inherited from
            <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeObservable.html#method__setAttrs">
                AttributeObservable
            </a>
            but overwritten in
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l760"><code>attribute&#x2F;js&#x2F;AttributeCore.js:760</code></a>
        </p>



    </div>

    <div class="description">
        Implementation behind the public setAttrs method, to set multiple attribute values.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attrs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        An object with attributes name/value pairs.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Optional data providing the circumstances for the change
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    A reference to the host object.
            </div>
        </div>


</div>
<div id="method__setAttrVal" class="method item private inherited">
    <h3 class="name"><code>_setAttrVal</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attrName</code>
                </li>
                <li class="arg">
                        <code>subAttrName</code>
                </li>
                <li class="arg">
                        <code>prevVal</code>
                </li>
                <li class="arg">
                        <code>newVal</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts]</code>
                </li>
                <li class="arg">
                        <code class="optional">[attrCfg]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l658"><code>attribute&#x2F;js&#x2F;AttributeCore.js:658</code></a>
        </p>



    </div>

    <div class="description">
        Updates the stored value of the attribute in the privately held State object,
if validation and setter passes.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attrName</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The attribute name.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">subAttrName</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The sub-attribute name, if setting a sub-attribute property ("x.y.z").
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">prevVal</code>
                        <span class="type">Any</span>


                    <div class="param-description">
                        The currently stored value of the attribute.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">newVal</code>
                        <span class="type">Any</span>


                    <div class="param-description">
                        The value which is going to be stored.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Optional data providing the circumstances for the change.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[attrCfg]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Optional config hash for the attribute. This is added for performance along the critical path,
where the calling method has already obtained the config from state.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    true if the new attribute value was stored, false if not.
            </div>
        </div>


</div>
<div id="method__setStateVal" class="method item private inherited">
    <h3 class="name"><code>_setStateVal</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code>value</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__setStateVal">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l640"><code>attribute&#x2F;js&#x2F;AttributeCore.js:640</code></a>
        </p>



    </div>

    <div class="description">
        Sets the stored value for the attribute, in either the
internal state object, or the state proxy if it exits
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">value</code>
                        <span class="type">Any</span>


                    <div class="param-description">
                        The value of the attribute
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_addAttr" class="method item inherited">
    <h3 class="name"><code>addAttr</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code>config</code>
                </li>
                <li class="arg">
                        <code>lazy</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>





        <span class="flag chainable">chainable</span>


    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method_addAttr">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l157"><code>attribute&#x2F;js&#x2F;AttributeCore.js:157</code></a>
        </p>



    </div>

    <div class="description">
        <p>
Adds an attribute with the provided configuration to the host object.
</p>
<p>
The config argument object supports the following properties:
</p>

<dl>
   <dt>value &#60;Any&#62;</dt>
   <dd>The initial value to set on the attribute</dd>

   <dt>valueFn &#60;Function | String&#62;</dt>
   <dd>
   <p>A function, which will return the initial value to set on the attribute. This is useful
   for cases where the attribute configuration is defined statically, but needs to
   reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined,
   the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which
   case the value property is used.</p>

   <p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p>
   </dd>

   <dt>readOnly &#60;boolean&#62;</dt>
   <dd>Whether or not the attribute is read only. Attributes having readOnly set to true
       cannot be modified by invoking the set method.</dd>

   <dt>writeOnce &#60;boolean&#62; or &#60;string&#62;</dt>
   <dd>
       Whether or not the attribute is "write once". Attributes having writeOnce set to true,
       can only have their values set once, be it through the default configuration,
       constructor configuration arguments, or by invoking set.
       <p>The writeOnce attribute can also be set to the string "initOnly",
        in which case the attribute can only be set during initialization
       (when used with Base, this means it can only be set during construction)</p>
   </dd>

   <dt>setter &#60;Function | String&#62;</dt>
   <dd>
   <p>The setter function used to massage or normalize the value passed to the set method for the attribute.
   The value returned by the setter will be the final stored value. Returning
   <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent
   the value from being stored.
   </p>

   <p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p>
   </dd>

   <dt>getter &#60;Function | String&#62;</dt>
   <dd>
   <p>
   The getter function used to massage or normalize the value returned by the get method for the attribute.
   The value returned by the getter function is the value which will be returned to the user when they
   invoke get.
   </p>

   <p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p>
   </dd>

   <dt>validator &#60;Function | String&#62;</dt>
   <dd>
   <p>
   The validator function invoked prior to setting the stored value. Returning
   false from the validator function will prevent the value from being stored.
   </p>

   <p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p>
   </dd>

   <dt>lazyAdd &#60;boolean&#62;</dt>
   <dd>Whether or not to delay initialization of the attribute until the first call to get/set it.
   This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through
   the <a href="#method_addAttrs">addAttrs</a> method.</dd>

</dl>

<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with
the context ("this") set to the host object.</p>

<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute,
and are not intended for public use.</p>
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">config</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        An object with attribute configuration property/value pairs, specifying the configuration for the attribute.

<p>
<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need
to protect the original values, you will need to merge the object.
</p>
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">lazy</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


                    <div class="param-description">
                        (optional) Whether or not to add this attribute lazily (on the first call to get/set).
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    A reference to the host object.
            </div>
        </div>


</div>
<div id="method_addAttrs" class="method item inherited">
    <h3 class="name"><code>addAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>cfgs</code>
                </li>
                <li class="arg">
                        <code>values</code>
                </li>
                <li class="arg">
                        <code>lazy</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>





        <span class="flag chainable">chainable</span>


    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method_addAttrs">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l823"><code>attribute&#x2F;js&#x2F;AttributeCore.js:823</code></a>
        </p>



    </div>

    <div class="description">
        Configures a group of attributes, and sets initial values.

<p>
<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning.
The caller is responsible for merging/cloning the configuration object if required.
</p>
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">cfgs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        An object with attribute name/configuration pairs.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">values</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        An object with attribute name/value pairs, defining the initial values to apply.
Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">lazy</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


                    <div class="param-description">
                        Whether or not to delay the intialization of these attributes until the first call to get/set.
Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
See <a href="#method_addAttr">addAttr</a>.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    A reference to the host object.
            </div>
        </div>


</div>
<div id="method_addTarget" class="method item inherited">
    <h3 class="name"><code>addTarget</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>o</code>
                </li>
            </ul><span class="paren">)</span>
        </div>






        <span class="flag chainable">chainable</span>


    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_addTarget">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-facade.js.html#l496"><code>event-custom&#x2F;js&#x2F;event-facade.js:496</code></a>
        </p>



    </div>

    <div class="description">
        Registers another EventTarget as a bubble target.  Bubble order
is determined by the order registered.  Multiple targets can
be specified.

Events can only bubble if emitFacade is true.

Included in the event-custom-complex submodule.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">o</code>
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html" class="crosslink external" target="_blank">EventTarget</a></span>


                    <div class="param-description">
                        the target to add
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_after" class="method item inherited">
    <h3 class="name"><code>after</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
                <li class="arg">
                        <code>fn</code>
                </li>
                <li class="arg">
                        <code class="optional">[context]</code>
                </li>
                <li class="arg">
                        <code class="optional">[arg*]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventHandle.html" class="crosslink external" target="_blank">EventHandle</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_after">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l812"><code>event-custom&#x2F;js&#x2F;event-target.js:812</code></a>
        </p>



    </div>

    <div class="description">
        Subscribe to a custom event hosted by this object.  The
supplied callback will execute after any listeners add
via the subscribe method, and after the default function,
if configured for the event, has executed.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">fn</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>


                    <div class="param-description">
                        The callback to execute in response to the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[context]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Override <code>this</code> object in callback
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[arg*]</code>
                        <span class="type">Any</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        0..n additional arguments to supply to the subscriber
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventHandle.html" class="crosslink external" target="_blank">EventHandle</a></span>:
                    A subscription handle capable of detaching the
                      subscription
            </div>
        </div>


</div>
<div id="method_attrAdded" class="method item inherited">
    <h3 class="name"><code>attrAdded</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method_attrAdded">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l319"><code>attribute&#x2F;js&#x2F;AttributeCore.js:319</code></a>
        </p>



    </div>

    <div class="description">
        Checks if the given attribute has been added to the host
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute to check.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    true if an attribute with the given name has been added, false if it hasn't.
        This method will return true for lazily added attributes.
            </div>
        </div>


</div>
<div id="method_before" class="method item inherited">
    <h3 class="name"><code>before</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type"></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_before">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l849"><code>event-custom&#x2F;js&#x2F;event-target.js:849</code></a>
        </p>



    </div>

    <div class="description">
        Executes the callback before a DOM event, custom event
or method.  If the first argument is a function, it
is assumed the target is a method.  For DOM and custom
events, this is an alias for Y.on.

For DOM and custom events:
type, callback, context, 0-n arguments

For methods:
callback, object (method host), methodName, context, 0-n arguments
    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                    detach handle
            </div>
        </div>


</div>
<div id="method_bubble" class="method item inherited">
    <h3 class="name"><code>bubble</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>evt</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_bubble">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-facade.js.html#l554"><code>event-custom&#x2F;js&#x2F;event-facade.js:554</code></a>
        </p>



    </div>

    <div class="description">
        Propagate an event.  Requires the event-custom-complex module.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">evt</code>
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/CustomEvent.html" class="crosslink external" target="_blank">CustomEvent</a></span>


                    <div class="param-description">
                        the custom event to propagate
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    the aggregated return value from Event.Custom.fire
            </div>
        </div>


</div>
<div id="method_destroy" class="method item inherited">
    <h3 class="name"><code>destroy</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html" class="crosslink external" target="_blank">BaseCore</a></span>
        </span>





        <span class="flag chainable">chainable</span>


    <div class="meta">
            <p>Inherited from
            <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#method_destroy">
                BaseObservable
            </a>
            but overwritten in
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l352"><code>base&#x2F;js&#x2F;BaseCore.js:352</code></a>
        </p>



    </div>

    <div class="description">
        Destroy lifecycle method. Invokes destructors for the class hierarchy.
    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html" class="crosslink external" target="_blank">BaseCore</a></span>:
                    A reference to this object
            </div>
        </div>


</div>
<div id="method_detach" class="method item inherited">
    <h3 class="name"><code>detach</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
                <li class="arg">
                        <code>fn</code>
                </li>
                <li class="arg">
                        <code>context</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html" class="crosslink external" target="_blank">EventTarget</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_detach">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l356"><code>event-custom&#x2F;js&#x2F;event-target.js:356</code></a>
        </p>



    </div>

    <div class="description">
        Detach one or more listeners the from the specified event
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        Either the handle to the subscriber or the
                       type of event.  If the type
                       is not specified, it will attempt to remove
                       the listener from all hosted events.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">fn</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>


                    <div class="param-description">
                        The subscribed function to unsubscribe, if not
                         supplied, all subscribers will be removed.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">context</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The custom object passed to subscribe.  This is
                       optional, but if supplied will be used to
                       disambiguate multiple listeners that are the same
                       (e.g., you subscribe many object using a function
                       that lives on the prototype)
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html" class="crosslink external" target="_blank">EventTarget</a></span>:
                    the host
            </div>
        </div>


</div>
<div id="method_detachAll" class="method item inherited">
    <h3 class="name"><code>detachAll</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_detachAll">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l479"><code>event-custom&#x2F;js&#x2F;event-target.js:479</code></a>
        </p>



    </div>

    <div class="description">
        Removes all listeners from the specified event.  If the event type
is not specified, all listeners from all hosted custom events will
be removed.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The type, or name of the event
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_extract" class="method item">
    <h3 class="name"><code>extract</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>filemap</code>
                </li>
                <li class="arg">
                        <code>dirmap</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l1287"><code>lib&#x2F;docparser.js:1287</code></a>
        </p>



    </div>

    <div class="description">
        <p>Accepts a map of filenames to file content.  Returns
a map of filenames to an array of API comment block
text.  This expects the comment to start with / **
on its own line, and end with * / on its own
line.  Override this function to provide an
alternative comment parser.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">filemap</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        <p>A map of filenames to file content</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">dirmap</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>


                    <div class="param-description">
                        <p>A map of file names to directory name</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    <p>A map of filenames to an array of extracted
comment text.</p>

            </div>
        </div>


</div>
<div id="method_fire" class="method item inherited">
    <h3 class="name"><code>fire</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
                <li class="arg">
                        <code>arguments</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_fire">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l673"><code>event-custom&#x2F;js&#x2F;event-target.js:673</code></a>
        </p>



    </div>

    <div class="description">
        Fire a custom event by name.  The callback functions will be executed
from the context specified when the event was created, and with the
following parameters.

The first argument is the event type, and any additional arguments are
passed to the listeners as parameters.  If the first of these is an
object literal, and the event is configured to emit an event facade,
that object is mixed into the event facade and the facade is provided
in place of the original object.

If the custom event object hasn't been created, then the event hasn't
been published and it has no subscribers.  For performance sake, we
immediate exit in this case.  This means the event won't bubble, so
if the intention is that a bubble target be notified, the event must
be published on this object first.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        The type of the event, or an object that contains
a 'type' property.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">arguments</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object*</a></span>


                    <div class="param-description">
                        an arbitrary set of parameters to pass to
the handler.  If the first of these is an object literal and the event is
configured to emit an event facade, the event facade will replace that
parameter after the properties the object literal contains are copied to
the event facade.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    True if the whole lifecycle of the event went through,
false if at any point the event propagation was halted.
            </div>
        </div>


</div>
<div id="method_get" class="method item inherited">
    <h3 class="name"><code>get</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Any</span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method_get">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l331"><code>attribute&#x2F;js&#x2F;AttributeCore.js:331</code></a>
        </p>



    </div>

    <div class="description">
        Returns the current value of the attribute. If the attribute
has been configured with a 'getter' function, this method will delegate
to the 'getter' to obtain the value of the attribute.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute. If the value of the attribute is an Object,
dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Any</span>:
                    The value of the attribute
            </div>
        </div>


</div>
<div id="method_getAttrs" class="method item inherited">
    <h3 class="name"><code>getAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attrs</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method_getAttrs">AttributeCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l780"><code>attribute&#x2F;js&#x2F;AttributeCore.js:780</code></a>
        </p>



    </div>

    <div class="description">
        Gets multiple attribute values.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attrs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


                    <div class="param-description">
                        Optional. An array of attribute names. If omitted, all attribute values are
returned. If set to true, all attributes modified from their initial values are returned.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    An object with attribute name/value pairs.
            </div>
        </div>


</div>
<div id="method_getEvent" class="method item inherited">
    <h3 class="name"><code>getEvent</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
                <li class="arg">
                        <code>prefixed</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/CustomEvent.html" class="crosslink external" target="_blank">CustomEvent</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_getEvent">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l793"><code>event-custom&#x2F;js&#x2F;event-target.js:793</code></a>
        </p>



    </div>

    <div class="description">
        Returns the custom event of the provided type has been created, a
falsy value otherwise
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        the type, or name of the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">prefixed</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        if true, the type is prefixed already
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/CustomEvent.html" class="crosslink external" target="_blank">CustomEvent</a></span>:
                    the custom event or null
            </div>
        </div>


</div>
<div id="method_getTargets" class="method item inherited">
    <h3 class="name"><code>getTargets</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type"></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_getTargets">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-facade.js.html#l523"><code>event-custom&#x2F;js&#x2F;event-facade.js:523</code></a>
        </p>



    </div>

    <div class="description">
        Returns an array of bubble targets for this object.
    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                    EventTarget[]
            </div>
        </div>


</div>
<div id="method_handlecomment" class="method item">
    <h3 class="name"><code>handlecomment</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>comment</code>
                </li>
                <li class="arg">
                        <code>file</code>
                </li>
                <li class="arg">
                        <code>line</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l1209"><code>lib&#x2F;docparser.js:1209</code></a>
        </p>



    </div>

    <div class="description">
        <p>Transforms a JavaDoc style comment block (less the start and end of it)
into a list of tag/text pairs. The leading space and '*' are removed,
but the remaining whitespace is preserved so that the output should be
friendly for both markdown and html parsers.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">comment</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        <p>The comment to parse</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">file</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        <p>The file it was parsed from</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">line</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        <p>The line number it was found on</p>

                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_implodeString" class="method item private">
    <h3 class="name"><code>implodeString</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>str</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l40"><code>lib&#x2F;docparser.js:40</code></a>
        </p>



    </div>

    <div class="description">
        <p>Flatten a string, remove all line breaks and replace them with a token</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">str</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        <p>The string to operate on</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    <p>The modified string</p>

            </div>
        </div>


</div>
<div id="method_implodeString" class="method item private">
    <h3 class="name"><code>implodeString</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>str</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l50"><code>lib&#x2F;docparser.js:50</code></a>
        </p>



    </div>

    <div class="description">
        <p>Un-flatten a string, replace tokens injected with <code>implodeString</code></p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">str</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        <p>The string to operate on</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    <p>The modified string</p>

            </div>
        </div>


</div>
<div id="method_init" class="method item inherited">
    <h3 class="name"><code>init</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>cfg</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html" class="crosslink external" target="_blank">BaseCore</a></span>
        </span>





        <span class="flag chainable">chainable</span>


    <div class="meta">
            <p>Inherited from
            <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#method_init">
                BaseObservable
            </a>
            but overwritten in
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l319"><code>base&#x2F;js&#x2F;BaseCore.js:319</code></a>
        </p>



    </div>

    <div class="description">
        Init lifecycle method, invoked during construction. Sets up attributes
and invokes initializers for the class hierarchy.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">cfg</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        Object with configuration property name/value pairs
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html" class="crosslink external" target="_blank">BaseCore</a></span>:
                    A reference to this object
            </div>
        </div>


</div>
<div id="method_modifyAttr" class="method item inherited">
    <h3 class="name"><code>modifyAttr</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code>config</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeExtras.js.html#l40"><code>attribute&#x2F;js&#x2F;AttributeExtras.js:40</code></a>
        </p>



    </div>

    <div class="description">
        Updates the configuration of an attribute which has already been added.
<p>
The properties which can be modified through this interface are limited
to the following subset of attributes, which can be safely modified
after a value has already been set on the attribute:
</p>
<dl>
 <dt>readOnly;</dt>
 <dt>writeOnce;</dt>
 <dt>broadcast; and</dt>
 <dt>getter.</dt>
</dl>
<p>
Note: New attributes cannot be added using this interface. New attributes must be
added using {{#crossLink "AttributeCore/addAttr:method"}}addAttr{{/crossLink}}, or an
appropriate manner for a class which utilises Attributes (e.g. the
{{#crossLink "Base/ATTRS:property"}}ATTRS{{/crossLink}} property in
{{#crossLink "Base"}}Base{{/crossLink}}).
</p>
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute whose configuration is to be updated.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">config</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        An object with configuration property/value pairs, specifying the configuration properties to modify.
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_on" class="method item inherited">
    <h3 class="name"><code>on</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
                <li class="arg">
                        <code>fn</code>
                </li>
                <li class="arg">
                        <code class="optional">[context]</code>
                </li>
                <li class="arg">
                        <code class="optional">[arg*]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventHandle.html" class="crosslink external" target="_blank">EventHandle</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_on">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l188"><code>event-custom&#x2F;js&#x2F;event-target.js:188</code></a>
        </p>



    </div>

    <div class="description">
        Subscribe a callback function to a custom event fired by this object or
from an object that bubbles its events to this object.

     this.on("change", this._onChange, this);

Callback functions for events published with <code>emitFacade = true</code> will
receive an <code>EventFacade</code> as the first argument (typically named "e").
These callbacks can then call <code>e.preventDefault()</code> to disable the
behavior published to that event's <code>defaultFn</code>.  See the <code>EventFacade</code>
API for all available properties and methods. Subscribers to
non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>
after the event name.

To subscribe to multiple events at once, pass an object as the first
argument, where the key:value pairs correspond to the eventName:callback.

     this.on({
         "attrChange" : this._onAttrChange,
         "change"     : this._onChange
     });

You can also pass an array of event names as the first argument to
subscribe to all listed events with the same callback.

     this.on([ "change", "attrChange" ], this._onChange);

Returning <code>false</code> from a callback is supported as an alternative to
calling <code>e.preventDefault(); e.stopPropagation();</code>.  However, it is
recommended to use the event methods whenever possible.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">fn</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>


                    <div class="param-description">
                        The callback to execute in response to the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[context]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Override <code>this</code> object in callback
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[arg*]</code>
                        <span class="type">Any</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        0..n additional arguments to supply to the subscriber
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventHandle.html" class="crosslink external" target="_blank">EventHandle</a></span>:
                    A subscription handle capable of detaching that
                      subscription
            </div>
        </div>


</div>
<div id="method_once" class="method item inherited">
    <h3 class="name"><code>once</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
                <li class="arg">
                        <code>fn</code>
                </li>
                <li class="arg">
                        <code class="optional">[context]</code>
                </li>
                <li class="arg">
                        <code class="optional">[arg*]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventHandle.html" class="crosslink external" target="_blank">EventHandle</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_once">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l124"><code>event-custom&#x2F;js&#x2F;event-target.js:124</code></a>
        </p>



    </div>

    <div class="description">
        Listen to a custom event hosted by this object one time.
This is the equivalent to <code>on</code> except the
listener is immediatelly detached when it is executed.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">fn</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>


                    <div class="param-description">
                        The callback to execute in response to the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[context]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Override <code>this</code> object in callback
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[arg*]</code>
                        <span class="type">Any</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        0..n additional arguments to supply to the subscriber
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventHandle.html" class="crosslink external" target="_blank">EventHandle</a></span>:
                    A subscription handle capable of detaching the
                      subscription
            </div>
        </div>


</div>
<div id="method_onceAfter" class="method item inherited">
    <h3 class="name"><code>onceAfter</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
                <li class="arg">
                        <code>fn</code>
                </li>
                <li class="arg">
                        <code class="optional">[context]</code>
                </li>
                <li class="arg">
                        <code class="optional">[arg*]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventHandle.html" class="crosslink external" target="_blank">EventHandle</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_onceAfter">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l146"><code>event-custom&#x2F;js&#x2F;event-target.js:146</code></a>
        </p>



    </div>

    <div class="description">
        Listen to a custom event hosted by this object one time.
This is the equivalent to <code>after</code> except the
listener is immediatelly detached when it is executed.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">fn</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>


                    <div class="param-description">
                        The callback to execute in response to the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[context]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Override <code>this</code> object in callback
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[arg*]</code>
                        <span class="type">Any</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        0..n additional arguments to supply to the subscriber
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventHandle.html" class="crosslink external" target="_blank">EventHandle</a></span>:
                    A subscription handle capable of detaching that
                      subscription
            </div>
        </div>


</div>
<div id="method_parse" class="method item">
    <h3 class="name"><code>parse</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>filemap</code>
                </li>
                <li class="arg">
                        <code>dirmap</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="../classes/DocParser.html" class="crosslink">DocParser</a></span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l1562"><code>lib&#x2F;docparser.js:1562</code></a>
        </p>



    </div>

    <div class="description">
        <p>Extracts and transforms the filemap provided to constructor</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">filemap</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>


                    <div class="param-description">
                        <p>A map of filenames to file content</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">dirmap</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>


                    <div class="param-description">
                        <p>A map of file names to directory name</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="../classes/DocParser.html" class="crosslink">DocParser</a></span>:
                    <p>this parser instance.  The total results
are available in parser.data.</p>

            </div>
        </div>


</div>
<div id="method_parseType" class="method item inherited">
    <h3 class="name"><code>parseType</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
                <li class="arg">
                        <code class="optional">[pre]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_parseType">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l168"><code>event-custom&#x2F;js&#x2F;event-target.js:168</code></a>
        </p>



            <p>Available since 3.3.0</p>
    </div>

    <div class="description">
        Takes the type parameter passed to 'on' and parses out the
various pieces that could be included in the type.  If the
event type is passed without a prefix, it will be expanded
to include the prefix one is supplied or the event target
is configured with a default prefix.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        the type
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[pre]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        The prefix. Defaults to this._yuievt.config.prefix
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>:
                    an array containing:
 * the detach category, if supplied,
 * the prefixed event type,
 * whether or not this is an after listener,
 * the supplied event type
            </div>
        </div>


</div>
<div id="method_processblock" class="method item">
    <h3 class="name"><code>processblock</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>an</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l1342"><code>lib&#x2F;docparser.js:1342</code></a>
        </p>



    </div>

    <div class="description">
        <p>Processes all the tags in a single comment block</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">an</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>


                    <div class="param-description">
                        <p>array of the tag/text pairs</p>

                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_publish" class="method item inherited">
    <h3 class="name"><code>publish</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/CustomEvent.html" class="crosslink external" target="_blank">CustomEvent</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_publish">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l503"><code>event-custom&#x2F;js&#x2F;event-target.js:503</code></a>
        </p>



    </div>

    <div class="description">
        Creates a new custom event of the specified type.  If a custom event
by that name already exists, it will not be re-created.  In either
case the custom event is returned.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        the type, or name of the event
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        optional config params.  Valid properties are:
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name optional">[broadcast=false]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>whether or not the YUI instance and YUI global
are notified when the event is fired.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[bubbles=true]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>Whether or not this event bubbles. Events can
only bubble if <code>emitFacade</code> is true.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[context=this]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>the default execution context for the listeners.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[defaultFn]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>the default function to execute when this event
fires if preventDefault was not called.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[emitFacade=false]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>whether or not this event emits a facade.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[prefix]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>the prefix for this targets events, e.g., 'menu' in 'menu:click'.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[fireOnce=false]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>if an event is configured to fire once,
new subscribers after the fire will be notified immediately.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[async=false]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>fireOnce event listeners will fire synchronously
if the event has already fired unless <code>async</code> is <code>true</code>.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[preventable=true]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>whether or not <code>preventDefault()</code> has an effect.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[preventedFn]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>a function that is executed when <code>preventDefault()</code> is called.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[queuable=false]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>whether or not this event can be queued during bubbling.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[silent]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>if silent is true, debug messages are not provided for this event.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[stoppedFn]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>a function that is executed when stopPropagation is called.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[monitored]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>specifies whether or not this event should send notifications about
when the event has been attached, detached, or published.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[type]</code>
                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>the event type (valid option if not provided as the first parameter to publish).</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/CustomEvent.html" class="crosslink external" target="_blank">CustomEvent</a></span>:
                    the custom event
            </div>
        </div>


</div>
<div id="method_removeAttr" class="method item inherited">
    <h3 class="name"><code>removeAttr</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeExtras.js.html#l90"><code>attribute&#x2F;js&#x2F;AttributeExtras.js:90</code></a>
        </p>



    </div>

    <div class="description">
        Removes an attribute from the host object
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute to be removed.
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_removeTarget" class="method item inherited">
    <h3 class="name"><code>removeTarget</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>o</code>
                </li>
            </ul><span class="paren">)</span>
        </div>






        <span class="flag chainable">chainable</span>


    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_removeTarget">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-facade.js.html#l533"><code>event-custom&#x2F;js&#x2F;event-facade.js:533</code></a>
        </p>



    </div>

    <div class="description">
        Removes a bubble target
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">o</code>
                        <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html" class="crosslink external" target="_blank">EventTarget</a></span>


                    <div class="param-description">
                        the target to remove
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_reset" class="method item inherited">
    <h3 class="name"><code>reset</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>





        <span class="flag chainable">chainable</span>


    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeExtras.html#method_reset">AttributeExtras</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeExtras.js.html#l100"><code>attribute&#x2F;js&#x2F;AttributeExtras.js:100</code></a>
        </p>



    </div>

    <div class="description">
        Resets the attribute (or all attributes) to its initial value, as long as
the attribute is not readOnly, or writeOnce.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        Optional. The name of the attribute to reset.  If omitted, all attributes are reset.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    A reference to the host object.
            </div>
        </div>


</div>
<div id="method_set" class="method item inherited">
    <h3 class="name"><code>set</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code>value</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>





        <span class="flag chainable">chainable</span>


    <div class="meta">
            <p>Inherited from
            <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeObservable.html#method_set">
                AttributeObservable
            </a>
            but overwritten in
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l388"><code>attribute&#x2F;js&#x2F;AttributeCore.js:388</code></a>
        </p>



    </div>

    <div class="description">
        Sets the value of an attribute.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The name of the attribute. If the
current value of the attribute is an Object, dot notation can be used
to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">value</code>
                        <span class="type">Any</span>


                    <div class="param-description">
                        The value to set the attribute to.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Optional data providing the circumstances for the change.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    A reference to the host object.
            </div>
        </div>


</div>
<div id="method_setAttrs" class="method item inherited">
    <h3 class="name"><code>setAttrs</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>attrs</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>





        <span class="flag chainable">chainable</span>


    <div class="meta">
            <p>Inherited from
            <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeObservable.html#method_setAttrs">
                AttributeObservable
            </a>
            but overwritten in
        <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l747"><code>attribute&#x2F;js&#x2F;AttributeCore.js:747</code></a>
        </p>



    </div>

    <div class="description">
        Sets multiple attribute values.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">attrs</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        An object with attributes name/value pairs.
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                        Optional data providing the circumstances for the change.
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    A reference to the host object.
            </div>
        </div>


</div>
<div id="method_stringlog" class="method item private">
    <h3 class="name"><code>stringlog</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>data</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l13"><code>lib&#x2F;docparser.js:13</code></a>
        </p>



    </div>

    <div class="description">
        <p>Parses the JSON data and formats it into a nice log string for
filename and line number: <code>/file/name.js:123</code></p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">data</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        <p>The data block from the parser</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    <p>The formatted string.</p>

            </div>
        </div>


</div>
<div id="method_subscribe" class="method item deprecated inherited">
    <h3 class="name"><code>subscribe</code></h3>

        <span class="paren">()</span>


        <span class="flag deprecated" title="use on">deprecated</span>






    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_subscribe">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l346"><code>event-custom&#x2F;js&#x2F;event-target.js:346</code></a>
        </p>


            <p>Deprecated: use on</p>

    </div>

    <div class="description">
        subscribe to an event
    </div>




</div>
<div id="method_toString" class="method item inherited">
    <h3 class="name"><code>toString</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>







    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method_toString">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l815"><code>base&#x2F;js&#x2F;BaseCore.js:815</code></a>
        </p>



    </div>

    <div class="description">
        Default toString implementation. Provides the constructor NAME
and the instance guid, if set.
    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    String representation for this object
            </div>
        </div>


</div>
<div id="method_transform" class="method item">
    <h3 class="name"><code>transform</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>commentmap</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l1433"><code>lib&#x2F;docparser.js:1433</code></a>
        </p>



    </div>

    <div class="description">
        <p>Transforms a map of filenames to arrays of comment blocks into a
JSON structure that represents the entire processed API doc info
and relationships between elements for the entire project.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">commentmap</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>


                    <div class="param-description">
                        <p>The hash of files and parsed comment blocks</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
                    <p>The transformed data for the project</p>

            </div>
        </div>


</div>
<div id="method_unindent" class="method item private">
    <h3 class="name"><code>unindent</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>content</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l1188"><code>lib&#x2F;docparser.js:1188</code></a>
        </p>



    </div>

    <div class="description">
        <p>Normalizes the initial indentation of the given <em>content</em> so that the first line
is unindented, and all other lines are unindented to the same degree as the
first line. So if the first line has four spaces at the beginning, then all
lines will be unindented four spaces. Ported from <a href="https://github.com/rgrove/selleck">Selleck</a></p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">content</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        <p>Text to unindent.</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    <p>Unindented text.</p>

            </div>
        </div>


</div>
<div id="method_unsubscribe" class="method item deprecated inherited">
    <h3 class="name"><code>unsubscribe</code></h3>

        <span class="paren">()</span>


        <span class="flag deprecated" title="use detach">deprecated</span>






    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_unsubscribe">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l469"><code>event-custom&#x2F;js&#x2F;event-target.js:469</code></a>
        </p>


            <p>Deprecated: use detach</p>

    </div>

    <div class="description">
        detach a listener
    </div>




</div>
<div id="method_unsubscribeAll" class="method item deprecated inherited">
    <h3 class="name"><code>unsubscribeAll</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>type</code>
                </li>
            </ul><span class="paren">)</span>
        </div>


        <span class="flag deprecated" title="use detachAll">deprecated</span>






    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/event-custom_js_event-target.js.html#l490"><code>event-custom&#x2F;js&#x2F;event-target.js:490</code></a>
        </p>


            <p>Deprecated: use detachAll</p>

    </div>

    <div class="description">
        Removes all listeners from the specified event.  If the event type
is not specified, all listeners from all hosted custom events will
be removed.
    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>


                    <div class="param-description">
                        The type, or name of the event
                    </div>

                </li>
            </ul>
        </div>



</div>
            </div>

            <div id="properties" class="api-class-tabpanel">
                <h2 class="off-left">Properties</h2>

<div id="property__allowAdHocAttrs" class="property item protected inherited">
    <h3 class="name"><code>_allowAdHocAttrs</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>


        <span class="flag protected">protected</span>



    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l155"><code>base&#x2F;js&#x2F;BaseCore.js:155</code></a>
        </p>


    </div>

    <div class="description">
        This property controls whether or not instances of this class should
allow users to add ad-hoc attributes through the constructor configuration
hash.

AdHoc attributes are attributes which are not defined by the class, and are
not handled by the MyClass._NON_ATTRS_CFG
    </div>

        <p><strong>Default:</strong> undefined (false)</p>


</div>
<div id="property_CORRECTIONS" class="property item">
    <h3 class="name"><code>CORRECTIONS</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>



        <span class="flag final">final</span>


    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l194"><code>lib&#x2F;docparser.js:194</code></a>
        </p>


    </div>

    <div class="description">
        <p>Common errors will get scrubbed instead of being ignored.</p>

    </div>



</div>
<div id="property_DIGESTERS" class="property item">
    <h3 class="name"><code>DIGESTERS</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>



        <span class="flag final">final</span>


    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l217"><code>lib&#x2F;docparser.js:217</code></a>
        </p>


    </div>

    <div class="description">
        <p>A map of the default tag processors, keyed by the
tag name.  Multiple tags can use the same digester
by supplying the string name that points to the
implementation rather than a function.</p>

    </div>



</div>
<div id="property_IGNORE_TAGLIST" class="property item">
    <h3 class="name"><code>IGNORE_TAGLIST</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>



        <span class="flag final">final</span>


    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l182"><code>lib&#x2F;docparser.js:182</code></a>
        </p>


    </div>

    <div class="description">
        <p>A list of ignored tags. These tags should be ignored because there is
likely to be used for purposes other than JSDoc tags in JavaScript comments.</p>

    </div>



</div>
<div id="property_name" class="property item deprecated inherited">
    <h3 class="name"><code>name</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

        <span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>




    <div class="meta">
                <p>Inherited from
                <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#property_name">BaseCore</a>:
        <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l297"><code>base&#x2F;js&#x2F;BaseCore.js:297</code></a>
        </p>

            <p>Deprecated: Use this.constructor.NAME</p>

    </div>

    <div class="description">
        The string used to identify the class of this object.
    </div>



</div>
<div id="property_TAGLIST" class="property item">
    <h3 class="name"><code>TAGLIST</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>



        <span class="flag final">final</span>


    <div class="meta">
                <p>
                Defined in
        <a href="../files/lib_docparser.js.html#l97"><code>lib&#x2F;docparser.js:97</code></a>
        </p>


    </div>

    <div class="description">
        <p>A list of known tags.  This populates a member variable
during initialization, and will be updated if additional
digesters are added.</p>

    </div>



</div>
            </div>

            <div id="attrs" class="api-class-tabpanel">
                <h2 class="off-left">Attributes</h2>

                    <div id="attr_currentclass" class="attr item">
                        <a name="config_currentclass"></a> 
                        <h3 class="name"><code>currentclass</code></h3>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l1040"><code>lib&#x2F;docparser.js:1040</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>The class currently being parsed</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>currentclassChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>currentclass</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_currentelement" class="attr item">
                        <a name="config_currentelement"></a> 
                        <h3 class="name"><code>currentelement</code></h3>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l1080"><code>lib&#x2F;docparser.js:1080</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>The element currently being parsed</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>currentelementChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>currentelement</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_currentfile" class="attr item">
                        <a name="config_currentfile"></a> 
                        <h3 class="name"><code>currentfile</code></h3>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l882"><code>lib&#x2F;docparser.js:882</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>The file currently being parsed</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>currentfileChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>currentfile</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_currentmodule" class="attr item">
                        <a name="config_currentmodule"></a> 
                        <h3 class="name"><code>currentmodule</code></h3>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l939"><code>lib&#x2F;docparser.js:939</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>The module currently being parsed</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>currentmoduleChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>currentmodule</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_currentsubmodule" class="attr item">
                        <a name="config_currentsubmodule"></a> 
                        <h3 class="name"><code>currentsubmodule</code></h3>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l999"><code>lib&#x2F;docparser.js:999</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>The submodule currently being parsed</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>currentsubmoduleChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>currentsubmodule</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_destroyed" class="attr item inherited">
                        <a name="config_destroyed"></a> 
                        <h3 class="name"><code>destroyed</code></h3>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                    
                    
                    
                    
                    
                    
                    
                            <span class="flag readonly">readonly</span>
                    
                        <div class="meta">
                                    <p>Inherited from
                                    <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#attr_destroyed">BaseCore</a>:
                            <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l212"><code>base&#x2F;js&#x2F;BaseCore.js:212</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            Flag indicating whether or not this object
                    has been through the destroy lifecycle phase.
                        </div>
                    
                            <p><strong>Default:</strong> false</p>
                    
                            <div class="emits box">
                                <h4>Fires event <code>destroyedChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>destroyed</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_digesters" class="attr item">
                        <a name="config_digesters"></a> 
                        <h3 class="name"><code>digesters</code></h3>
                        <span class="type"></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l822"><code>lib&#x2F;docparser.js:822</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>Digesters process the tag/text pairs found in a
                    comment block.  They are looked up by tag name.
                    The digester gets the tagname, the value, the
                    target object to apply values to, and the full
                    block that is being processed.  Digesters can
                    be declared as strings instead of a function --
                    in that case, the program will try to look up
                    the key listed and use the function there instead
                    (it is an alias).  Digesters can return a host
                    object in the case the tag defines a new key
                    block type (modules/classes/methods/events/properties)</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>digestersChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>digesters</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_dirmap" class="attr item">
                        <a name="config_dirmap"></a> 
                        <h3 class="name"><code>dirmap</code></h3>
                        <span class="type"></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l872"><code>lib&#x2F;docparser.js:872</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>A map of file names to directory name.  Provided in
                    case this needs to be used to reset the module name
                    appropriately -- currently not used</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>dirmapChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>dirmap</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_emitters" class="attr item">
                        <a name="config_emitters"></a> 
                        <h3 class="name"><code>emitters</code></h3>
                        <span class="type"></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l844"><code>lib&#x2F;docparser.js:844</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>Emitters will be schemas for the types of payloads
                    the parser will emit.  Not implemented.</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>emittersChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>emitters</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_filemap" class="attr item">
                        <a name="config_filemap"></a> 
                        <h3 class="name"><code>filemap</code></h3>
                        <span class="type"></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l864"><code>lib&#x2F;docparser.js:864</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>The map of file names to file content.</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>filemapChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>filemap</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_initialized" class="attr item inherited">
                        <a name="config_initialized"></a> 
                        <h3 class="name"><code>initialized</code></h3>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                    
                    
                    
                    
                    
                    
                    
                            <span class="flag readonly">readonly</span>
                    
                        <div class="meta">
                                    <p>Inherited from
                                    <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#attr_initialized">BaseCore</a>:
                            <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l198"><code>base&#x2F;js&#x2F;BaseCore.js:198</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            Flag indicating whether or not this object
                    has been through the init lifecycle phase.
                        </div>
                    
                            <p><strong>Default:</strong> false</p>
                    
                            <div class="emits box">
                                <h4>Fires event <code>initializedChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>initialized</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_mainmodule" class="attr item">
                        <a name="config_mainmodule"></a> 
                        <h3 class="name"><code>mainmodule</code></h3>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l903"><code>lib&#x2F;docparser.js:903</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>The main documentation block for the module itself.</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>mainmoduleChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>mainmodule</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
                    <div id="attr_syntaxtype" class="attr item">
                        <a name="config_syntaxtype"></a> 
                        <h3 class="name"><code>syntaxtype</code></h3>
                        <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    
                    
                    
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>
                                    Defined in
                            <a href="../files/lib_docparser.js.html#l855"><code>lib&#x2F;docparser.js:855</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>Comment syntax type.</p>
                    
                        </div>
                    
                    
                            <div class="emits box">
                                <h4>Fires event <code>syntaxtypeChange</code></h4>
                    
                                <p>
                                Fires when the value for the configuration attribute <code>syntaxtype</code> is
                                changed. You can listen for the event using the <code>on</code> method if you
                                wish to be notified before the attribute's value has changed, or
                                using the <code>after</code> method if you wish to be notified after the
                                attribute's value has changed.
                                </p>
                    
                                <div class="params">
                                    <h4>Parameters:</h4>
                    
                                    <ul class="params-list">
                                        <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                                            <div class="param-description">
                                                An Event Facade object with the following
                                                attribute-specific properties added:
                                            </div>
                    
                                            <ul class="params-list">
                                                <li class="param">
                                                    <code class="param-name">prevVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value of the attribute, prior to it being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">newVal</code>
                                                    <span class="type">Any</span>
                                                    <div class="param-description">The value the attribute is to be set to.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">attrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">The name of the attribute being set.</div>
                                                </li>
                                                <li class="param">
                                                    <code class="param-name">subAttrName</code>
                                                    <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                                                    <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
                                                </li>
                                            </ul>
                                        </li>
                                    </ul>
                                </div>
                            </div>
                    
                    </div>
            </div>

            <div id="events" class="api-class-tabpanel">
                <h2 class="off-left">Events</h2>

                    <div id="event_destroy" class="events item inherited">
                        <h3 class="name"><code>destroy</code></h3>
                        <span class="type"></span>
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>Inherited from
                                    <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#event_destroy">BaseObservable</a>:
                            <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseObservable.js.html#l163"><code>base&#x2F;js&#x2F;BaseObservable.js:163</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>
                    Lifecycle event for the destroy phase,
                    fired prior to destruction. Invoking the preventDefault
                    method on the event object provided to subscribers will
                    prevent destruction from proceeding.
                    </p>
                    <p>
                    Subscribers to the "after" moment of this event, will be notified
                    after destruction is complete (and as a result cannot prevent
                    destruction).
                    </p>
                        </div>
                    
                            <div class="params">
                                <h4>Event Payload:</h4>
                    
                                <ul class="params-list">
                                    <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                    
                                        <div class="param-description">
                                            Event object
                                        </div>
                    
                                    </li>
                                </ul>
                            </div>
                    
                    
                    </div>
                    <div id="event_init" class="events item inherited">
                        <h3 class="name"><code>init</code></h3>
                        <span class="type"></span>
                    
                    
                    
                    
                    
                        <div class="meta">
                                    <p>Inherited from
                                    <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#event_init">BaseObservable</a>:
                            <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseObservable.js.html#l62"><code>base&#x2F;js&#x2F;BaseObservable.js:62</code></a>
                            </p>
                    
                    
                        </div>
                    
                        <div class="description">
                            <p>
                    Lifecycle event for the init phase, fired prior to initialization.
                    Invoking the preventDefault() method on the event object provided
                    to subscribers will prevent initialization from occuring.
                    </p>
                    <p>
                    Subscribers to the "after" momemt of this event, will be notified
                    after initialization of the object is complete (and therefore
                    cannot prevent initialization).
                    </p>
                        </div>
                    
                            <div class="params">
                                <h4>Event Payload:</h4>
                    
                                <ul class="params-list">
                                    <li class="param">
                                            <code class="param-name">e</code>
                                            <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span>
                    
                    
                                        <div class="param-description">
                                            Event object, with a cfg property which
                    refers to the configuration object passed to the constructor.
                                        </div>
                    
                                    </li>
                                </ul>
                            </div>
                    
                    
                    </div>
            </div>
    </div>
</div>
                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
